#region License
// Copyright 2007-2008 Rory Plaire (codekaizen@gmail.com)
/*
 * This license governs use of the accompanying software. If you use the software, you
 * accept this license. If you do not accept the license, do not use the software.
 * 
 * 1. Definitions
 * The terms "reproduce," "reproduction," "derivative works," and "distribution" have the
 * same meaning here as under U.S. copyright law.
 * A "contribution" is the original software, or any additions or changes to the software.
 * A "contributor" is any person that distributes its contribution under this license.
 * "Licensed patents" are a contributor's patent claims that read directly on its contribution.
 * 
 * 2. Grant of Rights
 * (A) Copyright Grant- Subject to the terms of this license, including the license conditions 
 *     and limitations in section 3, each contributor grants you a non-exclusive, worldwide, 
 *     royalty-free copyright license to reproduce its contribution, prepare derivative works 
 *     of its contribution, and distribute its contribution or any derivative works that you create.
 * (B) Patent Grant- Subject to the terms of this license, including the license conditions and 
 *     limitations in section 3, each contributor grants you a non-exclusive, worldwide, royalty-free 
 *     license under its licensed patents to make, have made, use, sell, offer for sale, import, 
 *     and/or otherwise dispose of its contribution in the software or derivative works of the 
 *     contribution in the software.
 * 
 * 3. Conditions and Limitations
 * (A) No Trademark License- This license does not grant you rights to use any contributors' 
 *     name, logo, or trademarks.
 * (B) If you bring a patent claim against any contributor over patents that you claim are 
 *     infringed by the software, your patent license from such contributor to the software 
 *     ends automatically.
 * (C) If you distribute any portion of the software, you must retain all copyright, patent, 
 *     trademark, and attribution notices that are present in the software.
 * (D) If you distribute any portion of the software in source code form, you may do so only under 
 *     this license by including a complete copy of this license with your distribution. If you 
 *     distribute any portion of the software in compiled or object code form, you may only do so 
 *     under a license that complies with this license.
 * (E) The software is licensed "as-is." You bear the risk of using it. The contributors give no 
 *     express warranties, guarantees or conditions. You may have additional consumer rights under 
 *     your local laws which this license cannot change. To the extent permitted under your local laws, 
 *     the contributors exclude the implied warranties of merchantability, fitness for a particular 
 *     purpose and non-infringement.
 * 
 */
#endregion

using System;
using System.Collections.Generic;

namespace NPack.Interfaces
{
    /// <summary>
    /// Provides the interface for linearly transforming a matrix.
    /// </summary>
    /// <typeparam name="T">Type of component in the matrix.</typeparam>
    public interface ITransformMatrix<T> : IMatrix<T>
        where T : IEquatable<T>, IComparable<T>, IComputable<T>, IConvertible
    {
        /// <summary>
        /// Scales the matrix by the given <paramref name="amount"/> in all orthoganal columns.
        /// </summary>
        /// <param name="amount">Amount to scale by.</param>
        void Scale(T amount);

        /// <summary>
        /// Scales the matrix by the given <paramref name="amount"/> in all orthoganal columns.
        /// </summary>
        /// <param name="amount">Amount to scale by.</param>
        /// <param name="order">Order in which to apply the operation.</param>
        void Scale(T amount, MatrixOperationOrder order);

        /// <summary>
        /// Scales the matrix by the given vector <paramref name="scaleVector"/>.
        /// </summary>
        /// <param name="scaleVector">
        /// A vector with scaling components which 
        /// correspond to the affine transform dimensions.
        /// </param>
        void Scale(IVector<T> scaleVector);

        /// <summary>
        /// Scales the matrix by the given vector <paramref name="scaleVector"/>.
        /// </summary>
        /// <param name="scaleVector">
        /// A vector with scaling components which 
        /// correspond to the affine transform dimensions.
        /// </param>
        /// <param name="order">Order in which to apply the operation.</param>
        void Scale(IVector<T> scaleVector, MatrixOperationOrder order);

        /// <summary>
        /// Applies a shear to the transform.
        /// </summary>
        /// <param name="shearVector">The vector used to compute the shear.</param>
        void Shear(IVector<T> shearVector);

        /// <summary>
        /// Applies a shear to the transform.
        /// </summary>
        /// <param name="shearVector">The vector used to compute the shear.</param>
        /// <param name="order">Order in which to apply the operation.</param>
        void Shear(IVector<T> shearVector, MatrixOperationOrder order);

        /// <summary>
        /// Rotates the affine transform around the given <paramref name="axis"/>.
        /// </summary>
        /// <param name="axis">
        /// The axis to rotate around. May be an addition of the basis vectors.
        /// </param>
        /// <param name="radians">Angle to rotate through.</param>
        void RotateAlong(IVector<T> axis, Double radians);

        /// <summary>
        /// Rotates the affine transform around the given <paramref name="axis"/>.
        /// </summary>
        /// <param name="axis">
        /// The axis to rotate around. May be an addition of the basis vectors.
        /// </param>
        /// <param name="radians">Angle to rotate through.</param>
        /// <param name="order">Order in which to apply the operation.</param>
        void RotateAlong(IVector<T> axis, Double radians, MatrixOperationOrder order);

        /// <summary>
        /// Applies this transform to the given <paramref name="input"/> matrix.
        /// </summary>
        /// <param name="input">Matrix to transform.</param>
        /// <returns>
        /// The multiplication of this transform matrix with the input matrix.
        /// </returns>
        IMatrix<T> TransformMatrix(IMatrix<T> input);

        ///// <summary>
        ///// Applies this transform to the given <paramref name="input"/> matrix in place.
        ///// </summary>
        ///// <param name="input">Matrix to transform.</param>
        ///// <returns>
        ///// The multiplication of this transform matrix with the input matrix.
        ///// </returns>
        //void TransformMatrix(T[][] input);

        /// <summary>
        /// Applies this transform to the given <paramref name="input"/> vector.
        /// </summary>
        /// <param name="input">Vector to transform.</param>
        /// <returns>
        /// The multiplication of this transform matrix with the input vector.
        /// </returns>
        IVector<T> TransformVector(IVector<T> input);

        /// <summary>
        /// Applies this transform to the given <paramref name="input"/> vector in place.
        /// </summary>
        /// <param name="input">Vector to transform.</param>
        void TransformVector(T[] input);

        /// <summary>
        /// Applies this transform to the given <paramref name="input"/> vectors.
        /// </summary>
        /// <param name="input">Set of vectors to transform.</param>
        /// <returns>
        /// The multiplication of this transform matrix with each of the input vectors.
        /// </returns>
        IEnumerable<IVector<T>> TransformVectors(IEnumerable<IVector<T>> input);

        /// <summary>
        /// Applies this transform to the given <paramref name="input"/> vectors in place.
        /// </summary>
        /// <param name="input">Set of vectors to transform.</param>
        void TransformVectors(IEnumerable<T[]> input);
    }
}